Fzzy Config/me.fzzyhmstrs.fzzy_config.util/ValidationResult

ValidationResult

A result of any type T that is wrapped with an optional error message

Used to provide contextual error information "upstream" of where the error was encountered, which allows for better logging where upstream elements can collate error messages passed back to them into an organized and sensible error log.

This class has a private constructor to force the use of the pre-defined static instantiation methods

Author

fzzyhmstrs

Since

0.1.0

Parameters

result type, can be nullable

Types

Companion

object Companion

ErrorEntry

sealed interface ErrorEntry

Error context stored in a ValidationResult. This can represent an errored or non-errored state, can include multiple children contexts, and can include non-textual information (see ValidationResult.Errors.ACTION for example)

Errors

object Errors

Functions

also

fun <T> ValidationResult<T>.~~also~~(newTest: Boolean, error: String): ValidationResult<T>

fun <T, C : Any> ValidationResult<T>.also(newTest: Boolean, type: ValidationResult.ErrorEntry.Type<C>, builder: UnaryOperator<ValidationResult.ErrorEntry.Builder<C>>): ValidationResult<T>

fun <T> ValidationResult<T>.also(newTest: Boolean, type: ValidationResult.ErrorEntry.Type<String>, error: String, e: Throwable? = null): ValidationResult<T>

Adds another test, and potentially another error, to a Validation.

attachTo

fun <T> ValidationResult<T>.attachTo(mutable: ValidationResult.ErrorEntry.Mutable): ValidationResult<T>

Reports errors in this validation to an error consumer.

bimap

fun <N, T> ValidationResult<T>.bimap(to: Function<ValidationResult<T>, ValidationResult<out N>>): ValidationResult<N>

Maps this validation to a new type using a mapping function

consume

fun consume(c: Consumer<ValidationResult.ErrorEntry.Entry<*>>)

fun <C : Any> consume(t: ValidationResult.ErrorEntry.Type<C>, c: Consumer<ValidationResult.ErrorEntry.Entry<C>>)

Inspects the error of the result, if any, for errors of a particular type

get

fun get(): T

Gets the wrapped result value

getError

fun ~~getError~~(): String

Supplies the error message stored within

getErrorEntry

fun ~~getErrorEntry~~(): ValidationResult.ErrorEntry

Supplies the error context stored within, if any

has

fun <C : Any> has(t: ValidationResult.ErrorEntry.Type<C>): Boolean

Tests whether this results error entry contains the specified error type.

inmap

fun <N, T> ValidationResult<T>.inmap(to: Function<ValidationResult<T>, out N>): ValidationResult<N>

Maps this validation to a new type using a mapping function

isCritical

fun isCritical(): Boolean

Boolean check to determine if this result is holding a critical (exception-caused) error

isError

fun isError(): Boolean

Boolean check to determine if this result is holding an error

isValid

fun isValid(): Boolean

Boolean check to determine if this result is valid (no errors)

iterate

fun iterate(): Iterable<ValidationResult.ErrorEntry.Entry<*>>

Iterates over all ErrorEntry.Entry contained in this result

fun <C : Any> iterate(t: ValidationResult.ErrorEntry.Type<C>): Iterable<ValidationResult.ErrorEntry.Entry<C>>

Provides an iterable containing any applicable ErrorEntry.Entry of the provided type

log

@JvmOverloads

fun log(writer: BiConsumer<String, Throwable?> = ErrorEntry.ENTRY_WARN_LOGGER): ValidationResult<T>

Log this result if it is errored.

logPlain

@JvmOverloads

fun logPlain(writer: BiConsumer<String, Throwable?> = ErrorEntry.ENTRY_WARN_LOGGER): ValidationResult<T>

Log this result if it is errored.

map

fun <N, T> ValidationResult<T>.map(to: Function<T, out N>): ValidationResult<N>

Maps this validation's stored value to a new type using a mapping function

outmap

fun <N, T> ValidationResult<T>.outmap(to: Function<T, ValidationResult<out N>>): ValidationResult<N>

Maps this validation's stored value to a new type using a mapping function

report

fun <T> ValidationResult<T>.~~report~~(errorReporter: Consumer<String>): ValidationResult<T>

reports error, if any, to a provided reporter (such as a logger)

fun <T> ValidationResult<T>.~~report~~(errorBuilder: MutableList<String>): ValidationResult<T>

reports error, if any, to a provided string list

reportTo

fun <T> ValidationResult<T>.reportTo(errorReporter: BiConsumer<String, Throwable?>): ValidationResult<T>

Reports errors in this validation to an error consumer.

test

fun test(p: Predicate<ValidationResult.ErrorEntry.Entry<*>>)

Performs the provided predicate test on this results error entry and any of its children. Generally returns true on the first success.

fun <C : Any> test(t: ValidationResult.ErrorEntry.Type<C>, p: Predicate<ValidationResult.ErrorEntry.Entry<C>>): Boolean

Performs the provided predicate test on this results error entry and any of its children if they are of the provided type. Generally returns true on the first success.

toString

open override fun toString(): String

wrap

fun <T> ValidationResult<*>.wrap(newVal: T): ValidationResult<T>

Creates a new ValidationResult of type T wrapping the new value with the error(if any) from the receiver ValidationResult (of any type, does not need to match T)

writeError

fun ~~writeError~~(errors: List<String>)

Writes an error log to console if this validation result is errored

writeWarning

fun ~~writeWarning~~(errors: List<String>)

Writes a warning log to console if this validation result is errored